PBM-1649 Documented the ability to clean up outdated backups from external storages #330
+72
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ernal storages
modified: docs/features/multi-storage.md
modified: docs/reference/pbm-commands.md
modified: docs/usage/delete-backup.md
modified: docs/usage/schedule-backup.md
There was a problem hiding this comment.
Pull request overview
This PR documents the new capability in PBM version 2.13.0 to clean up outdated backups from external storages using the --profile flag with the --older-than flag.
Key changes:
- Added documentation for the
--profileflag in cleanup and delete-backup commands - Clarified metadata auto-update behavior for main storage cleanup operations
- Updated implementation specifics to reflect the new external storage cleanup capabilities
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/usage/schedule-backup.md | Added example and explanation of cleaning up backups from external storages using --profile flag |
| docs/usage/delete-backup.md | Documented deletion of backups from external storages, added --profile flag usage examples, and removed outdated admonition |
| docs/reference/pbm-commands.md | Added --profile flag documentation to cleanup and delete-backup command reference tables |
| docs/features/multi-storage.md | Expanded delete backups section with new time-based deletion capability for external storages and updated implementation specifics |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/features/multi-storage.md
Outdated
Comment on lines
121
to
127
| The `--profile` flag works only with the `--older-than` flag. If you pass it with the backup name, PBM fails the delete operation and reports an error. | ||
|
|
||
| You can use either the `pbm delete-backup` command to include only backups, or `pbm cleanup` command to also include point-in-time recovery oplog slices: | ||
|
|
||
| Example of the `pbm delete-backup` command: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Line 128 uses spaces for indentation while line 127 appears to use a tab. Ensure consistent indentation using spaces throughout the code block examples.
Suggested change
| The `--profile` flag works only with the `--older-than` flag. If you pass it with the backup name, PBM fails the delete operation and reports an error. | |
| You can use either the `pbm delete-backup` command to include only backups, or `pbm cleanup` command to also include point-in-time recovery oplog slices: | |
| Example of the `pbm delete-backup` command: | |
| ```bash | |
| The `--profile` flag works only with the `--older-than` flag. If you pass it with the backup name, PBM fails the delete operation and reports an error. | |
| You can use either the `pbm delete-backup` command to include only backups, or `pbm cleanup` command to also include point-in-time recovery oplog slices: | |
| Example of the `pbm delete-backup` command: | |
| ```bash |
Co-authored-by: Copilot <[email protected]>
it-percona
temporarily deployed
to
PBM-1649-Doc-delete-backups-from-profiles - pbm-docs PR #330
Render
Destroyed
Co-authored-by: Copilot <[email protected]>
jcechace
approved these changes
Jan 8, 2026
| 2. To start point-in-time recovery oplog slicing, you must make a backup on the main storage. A backup from an external storage is not considered a valid base backup for oplog slicing. | ||
| 3. PBM saves point-in-time recovery oplog ranges only on the main storage. Backups are saved on the storage that you define when starting a backup. | ||
| 4. Backup process on the external storage doesn’t stop point-in-time recovery oplog slicing on the main storage. Thus, PBM saves oplog chunks related to such backups on both the main and the external storages | ||
| 4. Backup process on the external storage doesn't stop point-in-time recovery oplog slicing on the main storage. Thus, PBM saves oplog chunks related to such backups on both the main and the external storages |
There was a problem hiding this comment.
Although this didn't change, I think it is related to
https://perconadev.atlassian.net/browse/PBM-1665
@boris-ilijic should we somehow rephrase it?
Member
There was a problem hiding this comment.
Yes, currently we do not have step 4. implemented and everything is described within the upper ticket. Let's wait for refinement and agree how should we handle this. Documentation can wait IMO, but if you prefer to update it within this PR I am fine with it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
modified: docs/features/multi-storage.md
modified: docs/reference/pbm-commands.md
modified: docs/usage/delete-backup.md
modified: docs/usage/schedule-backup.md